IPMT
Returns the interest payment for a given period for an investment, based on periodic, constant payments and a constant interest rate.
Syntax
expression.IPMT(arg1, arg2, arg3, arg4, arg5, arg6);
expression - A variable that represents a ApiWorksheetFunction class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| arg1 | Required | ApiRange | ApiName | number |
| arg2 | Required | ApiRange | ApiName | number |
| arg3 | Required | ApiRange | ApiName | number |
| arg4 | Required | ApiRange | ApiName | number |
| arg5 | Required | ApiRange | ApiName | number |
| arg6 | Required | ApiRange | ApiName | number |
Returns
number
Example
var oWorksheet = Api.GetActiveSheet();
var oFunction = Api.GetWorksheetFunction();
oWorksheet.GetRange("A1").SetValue(oFunction.IPMT(0.1/12, 1, 2*12, 2000, 0));